docs: Improve shortcut trigger docs
authorMatthias Clasen <mclasen@redhat.com>
Thu, 23 Jul 2020 16:57:08 +0000 (12:57 -0400)
committerMatthias Clasen <mclasen@redhat.com>
Thu, 23 Jul 2020 22:24:18 +0000 (18:24 -0400)
Point out the need to escape <> in xml.

gtk/gtkshortcuttrigger.c

index 65e3164b5b2744245e51e12e25a694d682edd49f..8364932c59637dc22dd7d0c192b963cd493500d9 100644 (file)
@@ -122,6 +122,10 @@ gtk_shortcut_trigger_trigger (GtkShortcutTrigger *self,
  *   - two valid trigger strings, separated by a `|` character, for a
  *     #GtkAlternativeTrigger: `<Control>q|<Control>w`
  *
+ * Note that you will have to escape the `<` and `>` characters when specifying
+ * triggers in XML files, such as GtkBuilder ui files. Use `&lt;` instead of
+ * `<` and `&gt;` instead of `>`.
+ *
  * Returns: (nullable) (transfer full): a new #GtkShortcutTrigger
  *   or %NULL on error
  */